GET v1/store/products?productIDs[0]={productIDs[0]}&productIDs[1]={productIDs[1]}&calculateMinimumPrice={calculateMinimumPrice}
Gets the products by their unique IDs.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| productIDs |
The list of unique IDs of the products. |
Collection of globally unique identifier |
Required |
| calculateMinimumPrice |
Indicates whether to calculate the minimum price. |
boolean |
Optional. Default value is True |
Body Parameters
None.
Response Information
Resource Description
Returns a list of the requested products.
Collection of ProductModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
The unique ID of the product. |
globally unique identifier |
None. |
| FriendlyID |
The friendly ID of the product. |
integer |
None. |
| Name |
The name of the product. |
string |
None. |
| ShortDescription |
The short description of the product. |
string |
None. |
| Description |
The full description of the product. |
string |
None. |
| ExternalID |
The ID of the product in an external application. |
string |
None. |
| CatalogNumber |
The catalog number of the product. |
string |
None. |
| HasPricing |
Indicates whether a price was defined for the product. |
boolean |
None. |
| ImageUrl |
The URL of the product image. |
string |
None. |
| Thumbnails |
The product thumbnails. |
Collection of string |
None. |
| Inventory |
The inventory of the product. |
ProductInventoryModel |
None. |
| Unit |
The unit of the product. |
ProductUnitModel |
None. |
| MinimumQuantity |
The minimum number of units that can be purchased. |
integer |
None. |
| MinimumPrice |
The minimum price of the product. |
ProductPriceModel |
None. |
| Type |
The type of the product. |
ProductType |
None. |
| Configuration |
The configuration of the product. |
ProductConfigurationModel |
None. |
Response Formats
application/json, text/json
[
{
"ID": "e6d8e7bb-c517-49c3-ae37-630d4b41aa50",
"FriendlyID": 2,
"Name": "sample string 3",
"ShortDescription": "sample string 4",
"Description": "sample string 5",
"ExternalID": "sample string 6",
"CatalogNumber": "sample string 7",
"HasPricing": true,
"ImageUrl": "sample string 9",
"Thumbnails": [
"sample string 1",
"sample string 2"
],
"Inventory": {
"Quantity": 1,
"AllowOutOfStockPurchase": true
},
"Unit": {
"ItemQuantity": 1,
"ItemType": {
"Name": "sample string 1",
"PluralName": "sample string 2"
},
"PackType": {
"Name": "sample string 1",
"PluralName": "sample string 2"
}
},
"MinimumQuantity": 10,
"MinimumPrice": {
"Price": 1.0,
"Tax": 2.0
},
"Attributes": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
],
"Type": 1,
"Configuration": {
"AllowQuickAddToCart": true,
"Quantity": {
"Minimum": 1,
"Maximum": 1,
"Changeable": true,
"Options": [
{
"Name": "sample string 1",
"Value": 2
},
{
"Name": "sample string 1",
"Value": 2
}
]
},
"Properties": [
{
"Name": "sample string 1",
"ID": "bce38b28-bdf1-4c08-a645-ac76c5a9de8f"
},
{
"Name": "sample string 1",
"ID": "bce38b28-bdf1-4c08-a645-ac76c5a9de8f"
}
]
}
},
{
"ID": "e6d8e7bb-c517-49c3-ae37-630d4b41aa50",
"FriendlyID": 2,
"Name": "sample string 3",
"ShortDescription": "sample string 4",
"Description": "sample string 5",
"ExternalID": "sample string 6",
"CatalogNumber": "sample string 7",
"HasPricing": true,
"ImageUrl": "sample string 9",
"Thumbnails": [
"sample string 1",
"sample string 2"
],
"Inventory": {
"Quantity": 1,
"AllowOutOfStockPurchase": true
},
"Unit": {
"ItemQuantity": 1,
"ItemType": {
"Name": "sample string 1",
"PluralName": "sample string 2"
},
"PackType": {
"Name": "sample string 1",
"PluralName": "sample string 2"
}
},
"MinimumQuantity": 10,
"MinimumPrice": {
"Price": 1.0,
"Tax": 2.0
},
"Attributes": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
],
"Type": 1,
"Configuration": {
"AllowQuickAddToCart": true,
"Quantity": {
"Minimum": 1,
"Maximum": 1,
"Changeable": true,
"Options": [
{
"Name": "sample string 1",
"Value": 2
},
{
"Name": "sample string 1",
"Value": 2
}
]
},
"Properties": [
{
"Name": "sample string 1",
"ID": "bce38b28-bdf1-4c08-a645-ac76c5a9de8f"
},
{
"Name": "sample string 1",
"ID": "bce38b28-bdf1-4c08-a645-ac76c5a9de8f"
}
]
}
}
]